[#69139] Create boards on Sprint start by myabc · Pull Request #22086 · opf/openproject

myabc · 2026-02-23T23:29:16Z

Ticket

https://community.openproject.org/wp/69139
https://community.openproject.org/wp/72942

What are you trying to accomplish?

Automatically create and configure a sprint task board when a user starts a sprint, so the team can immediately begin tracking work without manual board setup.

This branch also adds a matching skeleton Finish sprint flow for symmetry. For now, finishing a sprint only updates sprint status and does not change board behavior.

Important

There are some caveats:

creating work packages from the sprint task board does not work properly. This will rely on Feature/72227 sprints included in api get sprint and sprint on work package resource documentation #22307 (and possibly also Feature/71061 sprints manageable from work package #22328) being merged, as well as some follow-up integration work (e.g. updating WorkPackageFilterValues).
it is not possible to restore a deleted sprint task board: if a user deletes the board (via the board toolbar or index page), they cannot restore it directly. Users will encounter a 404 Not Found error on visiting the board via the sprint action menu's "Task board" item. If finished sprints were not filtered out in the UI as it currently stands, it might be possible to allow a workaround (e.g. to finish and restart the sprint).

Screenshots

Explicit sprint start / finish (WP #72942)

Start	Finish	Start when another sprint active

What approach did you choose and why?

I split the work into sprint board creation and an explicit Start sprint flow (OP #72942). The latter replaces lazy board creation on taskboard access, so board creation now follows sprint start and can use its own permissions.

Board linkage took two iterations. I first tried storing origin metadata in Boards::Grid#options, but that was awkward because options is YAML in a text column, not JSONB. I then switched to a nullable polymorphic link on Boards::Grid, which gives stable lookup without relying on serialized metadata.

This still leaves room for a narrower relation later. If sprint boards remain a dedicated concept, a direct sprint_id could be preferable for stronger semantics and proper referential integrity.

I also added a matching Finish sprint action and service for symmetry with the new start flow. At this stage (and since the behaviour with associated boards is not yet defined), it is essentially a stub - only transitioning sprint status.

What this PR does not do

Caveats: see above

Clean up and optimisations: although these PRs relate to this feature, these steps are technically out-of-scope / need their own review and can be probably be considered optional.

Merge checklist

Acceptance Criteria

Automatic Board Creation

Clicking "Start Sprint" from the backlog auto-creates a dedicated sprint board
User is automatically forwarded to the active sprint board
Board is named using convention: "[Project Name]: [Sprint Name]" (see ticket note re: naming discrepancy)
Board is immediately accessible via the project's board section
Board creation happens seamlessly without additional user prompts or configuration steps

Default Board Configuration

Columns map to workflow statuses (all statuses shown automatically, no status mapping)
Board filter automatically includes all issues assigned to the active sprint and all issue types enabled for the project

Board Visibility & Access

Board inherits project permissions automatically
All project members can view the board immediately

Preparatory & Validation

Create sprint work package filter
Adjust board permissions
Added/updated tests
Tested major browsers (Chrome, Firefox, Edge, ...)

github-actions · 2026-03-01T16:45:33Z

Deploying openproject with ⚡ PullPreview

Field	Value
Latest commit	`c1ef3ac`
Job	`deploy`
Status	✅ Deploy successful
Preview URL	https://pr-22086-69139-sprint-task-b-ip-23-88-121-1.my.opf.run:443

View logs

Copilot

Pull request overview

This PR replaces the legacy Backlogs sprint taskboard (server-rendered view + legacy JS/CSS) with an automatic redirect to a Work Package Board, creating the board on demand for a sprint.

Changes:

Add TaskBoards::CreateService to ensure a sprint board exists (create if missing, handle RecordNotUnique), plus unit specs.
Change RbTaskboardsController#show to create/load the board and redirect to project_work_package_board_path, with a localized failure flash.
Remove legacy taskboard view layer, feature/view specs, legacy frontend assets (Stimulus “taskboard-legacy” stack + vendor jQuery plugins + Sass), and drop jquery.cookie from frontend dependencies.

Reviewed changes

Copilot reviewed 30 out of 33 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`modules/backlogs/app/controllers/rb_taskboards_controller.rb`	Redirects sprint taskboard route to the generated board, with error fallback.
`modules/backlogs/app/services/task_boards/create_service.rb`	Implements board + per-status query/widget creation and an idempotent `.ensure` entrypoint.
`modules/backlogs/app/models/sprint.rb`	Adds `#board_name` used to name/lookup the sprint board.
`modules/backlogs/config/locales/en.yml`	Adds translation for automatic board creation failure.
`modules/backlogs/spec/services/task_boards/create_service_spec.rb`	New specs for the board creation service.
`modules/backlogs/spec/controllers/rb_taskboards_controller_spec.rb`	Updates controller spec to expect redirect behavior and failure handling.
`modules/backlogs/spec/models/sprint_spec.rb`	Adds spec coverage for `Sprint#board_name`.
`modules/backlogs/app/views/rb_taskboards/show.html.erb`	Removes legacy taskboard view template.
`modules/backlogs/app/helpers/taskboards_helper.rb`	Removes legacy helper used only by the removed view.
`modules/backlogs/spec/views/rb_taskboards/show_spec.rb`	Removes legacy view spec.
`modules/backlogs/spec/features/tasks_on_taskboard_spec.rb`	Removes legacy JS feature spec for tasks on taskboard.
`modules/backlogs/spec/features/impediments_spec.rb`	Removes legacy JS feature spec for impediments on taskboard.
`frontend/src/stimulus/controllers/dynamic/backlogs/*` (multiple)	Removes legacy taskboard JS implementation.
`frontend/src/vendor/jquery.*` (multiple)	Removes vendor plugins used by the legacy taskboard implementation.
`frontend/src/assets/sass/backlogs/*` (multiple)	Removes legacy taskboard/statistics/global styles and related imports.
`frontend/package.json` / `frontend/package-lock.json`	Removes `jquery.cookie` dependency.

Files not reviewed (1)

frontend/package-lock.json: Language not supported

You can also share your feedback on Copilot code review. Take the survey.

modules/backlogs/app/controllers/rb_taskboards_controller.rb

modules/backlogs/spec/services/task_boards/create_service_spec.rb

modules/backlogs/app/services/task_boards/create_service.rb

Copilot · 2026-03-04T01:05:55Z

@myabc I've opened a new pull request, #22177, to work on those changes. Once the pull request is ready, I'll request review from you.

modules/backlogs/spec/services/task_boards/create_service_spec.rb

myabc · 2026-03-11T03:45:13Z

@ulferts while this PR still needs some polishing, as well as feature specs, if you could give this a quick sanity check, that would be immensely helpful!

modules/backlogs/lib/open_project/backlogs/sprint_filter.rb

Copilot

Pull request overview

Copilot reviewed 19 out of 19 changed files in this pull request and generated 6 comments.

You can also share your feedback on Copilot code review. Take the survey.

modules/backlogs/spec/components/backlogs/sprint_menu_component_spec.rb

modules/boards/app/services/boards/sprint_task_board_create_service.rb

modules/backlogs/app/controllers/rb_taskboards_controller.rb

modules/backlogs/app/components/backlogs/sprint_menu_component.html.erb

These are commands, not partial updates, so POST is the correct HTTP method semantically.

Extracts failure aggregation into its own method.

The `.visible` scope returns 404 before `authorize` runs, so expects `:not_found` instead of `:forbidden` for members without permission.

Introduces `Sprints::StartContract` inheriting from `BaseContract` to validate permissions, sprint status, and active sprint uniqueness at the service layer. Refactors `Sprints::StartService` to use `BaseServices::BaseContracted` with contract integration.

Introduces `Agile::Sprint.receiving_projects(sprint)` scope returning all projects with work packages on the sprint. Updates `ensure_task_boards` to create boards for all receiving projects. Moves `board_name` from model to service.

The `load_sprint_and_project` callback already calls `load_project` for start/finish actions. Including `SPRINT_STATE_ACTIONS` in the separate `load_project` before_action caused it to run twice per request.

`Status.where(id:)` does not preserve the order of the input IDs. Extracts `statuses_in_order` to look up statuses by ID and return them in the widget column order from the previous sprint board.

Merges identical `respond_with_start_failure` and `respond_with_finish_failure` into a single method. Extracts `fallback_responses_for` following the pattern in `Projects::StatusController`.

myabc · 2026-03-23T01:57:54Z

Update 22.03.26 Here are some of the assumptions relating to the last couple commits:

receiving_projects mirrors sprint_source: a receive_shared project resolves to its closest share_subprojects ancestor, falling back to the global share_all_projects sharer. receiving_projects is the inverse of that lookup.
At most one global sharer: global_sprint_sharer_relation uses .limit(1) without ordering — multiple share_all_projects projects would produce nondeterministic behavior.
Closer sharer always shadows: a share_subprojects ancestor always takes precedence over the global sharer for any receiver beneath it.
User.system for board creation: the starting user may lack permissions in receiving projects, so boards are created as User.system.
Work package projects included: any project with work packages on the sprint gets a board, regardless of sharing settings.
All boards must succeed: ensure_task_boards returns early on failure — the sprint only becomes active if every board is created successfully.

ulferts

Getting there, @myabc .

The one thing I am currently unsure about is how to enforce having one active sprint in a project with the sharing model we agreed on. I hope to clear this up today.

The rest is just tiny things.

modules/backlogs/app/components/backlogs/sprint_menu_component.rb

config/locales/en.yml

modules/backlogs/app/components/backlogs/sprint_header_component.rb

modules/backlogs/app/contracts/sprints/start_contract.rb

ulferts · 2026-03-23T09:44:06Z

modules/backlogs/app/controllers/rb_sprints_controller.rb


+  def start
+    return render_403 unless OpenProject::FeatureDecisions.scrum_projects_active?
+    return render_404 unless @sprint.in_planning?


I personally don't see the benefit of doing this here. The loading of the sprint itself will already return a 404 if the sprint itself is not visible.

The routing constraint to me offers no benefits on top of that. This is a post/patch action so no information to glean from it anyway. But this is semantics so I accept that there are different opinions on this one and adapting is not a prerequisite for merging.

Depending on what is decided in today's weekly on where a sprint can be activated/finished from, the first guard might have to go.

modules/backlogs/spec/models/agile/sprints/scopes/receiving_projects_spec.rb

modules/backlogs/spec/services/sprints/start_service_spec.rb

modules/boards/app/services/boards/sprint_task_board_create_service.rb

ulferts · 2026-03-23T10:30:08Z

modules/boards/app/services/boards/sprint_task_board_create_service.rb

+        type: "action",
+        attribute: "status",
+        highlightingMode: "priority",
+        filters: [{ sprint_id: { operator: "=", values: [params[:sprint].id.to_s] } }]


The filter is provided in #22414

…ask-boards # Conflicts: # modules/backlogs/app/controllers/rb_sprints_controller.rb # modules/backlogs/spec/components/backlogs/sprint_menu_component_spec.rb # modules/backlogs/spec/features/sprints/edit_spec.rb # modules/backlogs/spec/support/pages/backlogs.rb

Dev merge moved sprint menu helpers from `Pages::Backlogs` to `Pages::SprintPlanning`. Updates the spec to match.

Moves `must_be_in_planning` and `only_one_active_sprint_allowed` from core `config/locales/en.yml` to the backlogs module's locale file, as these are sprint-specific error messages.

Removes the `project: sprint.project` default parameter from `SprintHeaderComponent#initialize`. All callers already pass `project:` explicitly, so the default was unnecessary and could mask missing arguments. Updates the component spec to pass `project:` explicitly.

Drops the `.active` scope from `shared_receiver_projects` in `ReceivingProjects`. The visibility of archived projects is already handled at the controller/view layer, so filtering here is redundant and can cause incorrect results. Adds spec coverage for the `share_subprojects` ancestor blocking behaviour when the source shares globally.

Replaces the map-then-aggregate pattern with a simpler loop that calls `add_dependent!` on a single `ServiceResult`. Since `add_dependent!` automatically propagates failure via `merge_success!`, no separate aggregation step is needed.

Moves the inline `@sprints.select(&:active?).map(&:id)` computation from the ERB partial into `load_backlogs` in the controller. Passes `@active_sprint_ids` to both the agile list and sprint planning list partials.

Uses `params[:project].type_ids` instead of `Task.type` when the sprint has no work packages. This avoids the dependency on the global backlogs Setting and uses the types actually enabled for the project. Removes the now-unnecessary `Setting.plugin_openproject_backlogs` stubs from both service specs and ensures projects are created with the required types.

modules/backlogs/app/components/backlogs/sprint_menu_component.rb

Allows start and finish from receiving projects while keeping the command permission on the sprint source project. Starting still requires board access in the rendered project because success redirects to that project's board. Adds `can_start?` and `can_start_or_finish?` class methods to `StartContract` so permission logic is shared between the controller and `SprintMenuComponent`. Uses `deny_access` instead of `render_403` to handle anonymous users correctly.

Replaces five inline subqueries for the source project's id, lft, and rgt with a single `WITH source AS (...)` CTE. Uses Rails' `.with()` method already established in the codebase.

myabc force-pushed the feature/69139-sprint-task-boards branch from da50e0d to c896461 Compare March 1, 2026 16:23

myabc added pullpreview DO NOT MERGE feature labels Mar 1, 2026

myabc force-pushed the feature/69139-sprint-task-boards branch from c896461 to d864085 Compare March 1, 2026 16:45

myabc force-pushed the feature/69139-sprint-task-boards branch 2 times, most recently from 0243a84 to b94a116 Compare March 3, 2026 22:07

myabc requested a review from Copilot March 3, 2026 22:08

myabc removed the DO NOT MERGE label Mar 3, 2026

Copilot started reviewing on behalf of myabc March 3, 2026 22:08 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

Copilot AI mentioned this pull request Mar 4, 2026

Add sprint and task type filters to automatic sprint task board creation #22177

Merged

3 tasks

github-advanced-security bot found potential problems Mar 5, 2026

View reviewed changes

modules/backlogs/spec/services/task_boards/create_service_spec.rb Fixed Show fixed Hide fixed

modules/backlogs/spec/services/task_boards/create_service_spec.rb Fixed Show fixed Hide fixed

myabc force-pushed the feature/69139-sprint-task-boards branch from d9d757d to 4b0f8eb Compare March 5, 2026 03:56

myabc added the DO NOT MERGE label Mar 8, 2026

myabc force-pushed the feature/69139-sprint-task-boards branch 5 times, most recently from 400c7c4 to 1598c02 Compare March 11, 2026 02:55

myabc requested a review from Copilot March 11, 2026 03:43

Copilot started reviewing on behalf of myabc March 11, 2026 03:44 View session

myabc force-pushed the feature/69139-sprint-task-boards branch from 3b5e2cd to 6b1b9d4 Compare March 11, 2026 03:47

myabc commented Mar 11, 2026

View reviewed changes

modules/backlogs/lib/open_project/backlogs/sprint_filter.rb Show resolved Hide resolved

Copilot AI reviewed Mar 11, 2026

View reviewed changes

myabc force-pushed the feature/69139-sprint-task-boards branch 2 times, most recently from 601636f to 50b109c Compare March 11, 2026 15:52

myabc added 4 commits March 21, 2026 23:17

Use POST for sprint start and finish actions

089bbed

These are commands, not partial updates, so POST is the correct HTTP method semantically.

Fix Rubocop ABC size in before_perform

81f0b66

Extracts failure aggregation into its own method.

Fix taskboard controller spec expectation

8756818

The `.visible` scope returns 404 before `authorize` runs, so expects `:not_found` instead of `:forbidden` for members without permission.

myabc force-pushed the feature/69139-sprint-task-boards branch from fd1c67c to 39b018e Compare March 22, 2026 03:18

myabc added 4 commits March 22, 2026 00:31

Add receiving_projects and boards

fcc1793

Introduces `Agile::Sprint.receiving_projects(sprint)` scope returning all projects with work packages on the sprint. Updates `ensure_task_boards` to create boards for all receiving projects. Moves `board_name` from model to service.

Remove redundant load_project for start/finish

c7a5e48

The `load_sprint_and_project` callback already calls `load_project` for start/finish actions. Including `SPRINT_STATE_ACTIONS` in the separate `load_project` before_action caused it to run twice per request.

Remove unused board error locale

daf0e11

Preserve status column order from previous board

e6a6ba0

`Status.where(id:)` does not preserve the order of the input IDs. Extracts `statuses_in_order` to look up statuses by ID and return them in the widget column order from the previous sprint board.

myabc force-pushed the feature/69139-sprint-task-boards branch from 39b018e to e6a6ba0 Compare March 22, 2026 04:32

myabc added 2 commits March 22, 2026 00:51

Avoid sprint menu active-sprint N+1

5d012d6

DRY up start/finish failure response handling

aa93458

Merges identical `respond_with_start_failure` and `respond_with_finish_failure` into a single method. Extracts `fallback_responses_for` following the pattern in `Projects::StatusController`.

ulferts requested changes Mar 23, 2026

View reviewed changes

myabc added 6 commits March 23, 2026 12:59

Use SprintPlanning page object in start_finish_spec

600922d

Dev merge moved sprint menu helpers from `Pages::Backlogs` to `Pages::SprintPlanning`. Updates the spec to match.

Move sprint error locales to backlogs module

a9d7d52

Moves `must_be_in_planning` and `only_one_active_sprint_allowed` from core `config/locales/en.yml` to the backlogs module's locale file, as these are sprint-specific error messages.

Simplify ensure_task_boards with add_dependent!

10ca498

Replaces the map-then-aggregate pattern with a simpler loop that calls `add_dependent!` on a single `ServiceResult`. Since `add_dependent!` automatically propagates failure via `merge_success!`, no separate aggregation step is needed.

myabc force-pushed the feature/69139-sprint-task-boards branch from f07cb72 to 10ca498 Compare March 23, 2026 13:58

myabc added 2 commits March 23, 2026 14:00

Move active_sprint_ids computation to controller

2d7780d

Moves the inline `@sprints.select(&:active?).map(&:id)` computation from the ERB partial into `load_backlogs` in the controller. Passes `@active_sprint_ids` to both the agile list and sprint planning list partials.

myabc commented Mar 23, 2026

View reviewed changes

modules/backlogs/app/components/backlogs/sprint_menu_component.rb Outdated Show resolved Hide resolved

myabc added 2 commits March 23, 2026 18:06

Use active scope in sprint menu

a7662cd

myabc requested a review from ulferts March 23, 2026 18:10

myabc added needs review and removed DO NOT MERGE labels Mar 23, 2026

Use CTE in shared_receiver_projects

c1ef3ac

Replaces five inline subqueries for the source project's id, lft, and rgt with a single `WITH source AS (...)` CTE. Uses Rails' `.with()` method already established in the codebase.

Conversation

myabc commented Feb 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Ticket

What are you trying to accomplish?

Screenshots

Explicit sprint start / finish (WP #72942)

What approach did you choose and why?

What this PR does not do

Merge checklist

Acceptance Criteria

Automatic Board Creation

Default Board Configuration

Board Visibility & Access

Preparatory & Validation

Uh oh!

github-actions bot commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying openproject with ⚡ PullPreview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Mar 4, 2026

Uh oh!

Uh oh!

Uh oh!

myabc commented Mar 11, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

myabc commented Mar 23, 2026

Uh oh!

ulferts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ulferts Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ulferts Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

myabc commented Feb 23, 2026 •

edited

Loading

github-actions bot commented Mar 1, 2026 •

edited

Loading